home *** CD-ROM | disk | FTP | other *** search
- <refentry id="libgimp-gimplayer" revision="19 Jan 2001">
- <refmeta>
- <refentrytitle>gimplayer</refentrytitle>
- <manvolnum>3</manvolnum>
- <refmiscinfo>LIBGIMP Library</refmiscinfo>
- </refmeta>
-
- <refnamediv>
- <refname>gimplayer</refname><refpurpose></refpurpose>
- </refnamediv>
-
- <refsynopsisdiv><title>Synopsis</title>
- <synopsis>
-
-
-
- <link linkend="gint32">gint32</link> <link linkend="gimp-layer-new">gimp_layer_new</link> (<link linkend="gint32">gint32</link> image_ID,
- <link linkend="gchar">gchar</link> *name,
- <link linkend="gint">gint</link> width,
- <link linkend="gint">gint</link> height,
- <link linkend="GimpImageType">GimpImageType</link> type,
- <link linkend="gdouble">gdouble</link> opacity,
- <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> mode);
- <link linkend="gint32">gint32</link> <link linkend="gimp-layer-copy">gimp_layer_copy</link> (<link linkend="gint32">gint32</link> layer_ID);
- <link linkend="gint32">gint32</link> <link linkend="gimp-layer-create-mask">gimp_layer_create_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="GimpAddMaskType">GimpAddMaskType</link> mask_type);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-scale">gimp_layer_scale</link> (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gint">gint</link> new_width,
- <link linkend="gint">gint</link> new_height,
- <link linkend="gboolean">gboolean</link> local_origin);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-resize">gimp_layer_resize</link> (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gint">gint</link> new_width,
- <link linkend="gint">gint</link> new_height,
- <link linkend="gint">gint</link> offx,
- <link linkend="gint">gint</link> offy);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-delete">gimp_layer_delete</link> (<link linkend="gint32">gint32</link> layer_ID);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-translate">gimp_layer_translate</link> (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gint">gint</link> offx,
- <link linkend="gint">gint</link> offy);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-add-alpha">gimp_layer_add_alpha</link> (<link linkend="gint32">gint32</link> layer_ID);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-offsets">gimp_layer_set_offsets</link> (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gint">gint</link> offx,
- <link linkend="gint">gint</link> offy);
- <link linkend="gint32">gint32</link> <link linkend="gimp-layer-mask">gimp_layer_mask</link> (<link linkend="gint32">gint32</link> layer_ID);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-is-floating-sel">gimp_layer_is_floating_sel</link> (<link linkend="gint32">gint32</link> layer_ID);
- <link linkend="gchar">gchar</link>* <link linkend="gimp-layer-get-name">gimp_layer_get_name</link> (<link linkend="gint32">gint32</link> layer_ID);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-name">gimp_layer_set_name</link> (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gchar">gchar</link> *name);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-get-visible">gimp_layer_get_visible</link> (<link linkend="gint32">gint32</link> layer_ID);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-visible">gimp_layer_set_visible</link> (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gboolean">gboolean</link> visible);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-get-preserve-trans">gimp_layer_get_preserve_trans</link> (<link linkend="gint32">gint32</link> layer_ID);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-preserve-trans">gimp_layer_set_preserve_trans</link> (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gboolean">gboolean</link> preserve_trans);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-get-apply-mask">gimp_layer_get_apply_mask</link> (<link linkend="gint32">gint32</link> layer_ID);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-apply-mask">gimp_layer_set_apply_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gboolean">gboolean</link> apply_mask);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-get-show-mask">gimp_layer_get_show_mask</link> (<link linkend="gint32">gint32</link> layer_ID);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-show-mask">gimp_layer_set_show_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gboolean">gboolean</link> show_mask);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-get-edit-mask">gimp_layer_get_edit_mask</link> (<link linkend="gint32">gint32</link> layer_ID);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-edit-mask">gimp_layer_set_edit_mask</link> (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gboolean">gboolean</link> edit_mask);
- <link linkend="gdouble">gdouble</link> <link linkend="gimp-layer-get-opacity">gimp_layer_get_opacity</link> (<link linkend="gint32">gint32</link> layer_ID);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-opacity">gimp_layer_set_opacity</link> (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gdouble">gdouble</link> opacity);
- <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> <link linkend="gimp-layer-get-mode">gimp_layer_get_mode</link> (<link linkend="gint32">gint32</link> layer_ID);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-mode">gimp_layer_set_mode</link> (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> mode);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-get-linked">gimp_layer_get_linked</link> (<link linkend="gint32">gint32</link> layer_ID);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-linked">gimp_layer_set_linked</link> (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gboolean">gboolean</link> linked);
- <link linkend="gint">gint</link> <link linkend="gimp-layer-get-tattoo">gimp_layer_get_tattoo</link> (<link linkend="gint32">gint32</link> layer_ID);
- <link linkend="gboolean">gboolean</link> <link linkend="gimp-layer-set-tattoo">gimp_layer_set_tattoo</link> (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gint">gint</link> tattoo);
- #define <link linkend="gimp-layer-get-mask-id">gimp_layer_get_mask_id</link>
- #define <link linkend="gimp-layer-get-image-id">gimp_layer_get_image_id</link>
- #define <link linkend="gimp-layer-is-floating-selection">gimp_layer_is_floating_selection</link>
- #define <link linkend="gimp-layer-get-preserve-transparency">gimp_layer_get_preserve_transparency</link>
- #define <link linkend="gimp-layer-set-preserve-transparency">gimp_layer_set_preserve_transparency</link>
- </synopsis>
- </refsynopsisdiv>
-
-
-
-
-
- <refsect1>
- <title>Description</title>
- <para>
-
- </para>
- </refsect1>
-
- <refsect1>
- <title>Details</title>
- <refsect2>
- <title><anchor id="gimp-layer-new">gimp_layer_new ()</title>
- <programlisting><link linkend="gint32">gint32</link> gimp_layer_new (<link linkend="gint32">gint32</link> image_ID,
- <link linkend="gchar">gchar</link> *name,
- <link linkend="gint">gint</link> width,
- <link linkend="gint">gint</link> height,
- <link linkend="GimpImageType">GimpImageType</link> type,
- <link linkend="gdouble">gdouble</link> opacity,
- <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> mode);</programlisting>
- <para>
- Create a new layer.
- </para>
- <para>
- This procedure creates a new layer with the specified width, height,
- and type. Name, opacity, and mode are also supplied parameters. The
- new layer still needs to be added to the image, as this is not
- automatic. Add the new layer with the 'gimp_image_add_layer'
- command. Other attributes such as layer mask modes, and offsets
- should be set with explicit procedure calls.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>image_ID</parameter> :</entry>
- <entry> The image to which to add the layer.
- </entry></row>
- <row><entry align="right"><parameter>name</parameter> :</entry>
- <entry> The layer name.
- </entry></row>
- <row><entry align="right"><parameter>width</parameter> :</entry>
- <entry> The layer width.
- </entry></row>
- <row><entry align="right"><parameter>height</parameter> :</entry>
- <entry> The layer height.
- </entry></row>
- <row><entry align="right"><parameter>type</parameter> :</entry>
- <entry> The layer type.
- </entry></row>
- <row><entry align="right"><parameter>opacity</parameter> :</entry>
- <entry> The layer opacity.
- </entry></row>
- <row><entry align="right"><parameter>mode</parameter> :</entry>
- <entry> The layer combination mode.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The newly created layer.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-copy">gimp_layer_copy ()</title>
- <programlisting><link linkend="gint32">gint32</link> gimp_layer_copy (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
- <para>
- Copy a layer.
- </para>
- <para>
- This procedure copies the specified layer and returns the copy. The
- newly copied layer is for use within the original layer's image. It
- should not be subsequently added to any other image. If you create
- a copy of the background layer, remember to add an alpha channel
- before you add the new layer to the image.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer to copy.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The newly copied layer.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-create-mask">gimp_layer_create_mask ()</title>
- <programlisting><link linkend="gint32">gint32</link> gimp_layer_create_mask (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="GimpAddMaskType">GimpAddMaskType</link> mask_type);</programlisting>
- <para>
- Create a layer mask for the specified specified layer.
- </para>
- <para>
- This procedure creates a layer mask for the specified layer. Layer
- masks serve as an additional alpha channel for a layer. Three
- different types of masks are allowed initially: completely white
- masks (which will leave the layer fully visible), completely black
- masks (which will give the layer complete transparency, and the
- layer's already existing alpha channel (which will leave the layer
- fully visible, but which may be more useful than a white mask). The
- layer mask still needs to be added to the layer. This can be done
- with a call to 'gimage_add_layer_mask'.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer to which to add the mask.
- </entry></row>
- <row><entry align="right"><parameter>mask_type</parameter> :</entry>
- <entry> The type of mask.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The newly created mask.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-scale">gimp_layer_scale ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_scale (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gint">gint</link> new_width,
- <link linkend="gint">gint</link> new_height,
- <link linkend="gboolean">gboolean</link> local_origin);</programlisting>
- <para>
- Scale the layer to the specified extents.
- </para>
- <para>
- This procedure scales the layer so that it's new width and height
- are equal to the supplied parameters. The \"local_origin\" parameter
- specifies whether to scale from the center of the layer, or from the
- image origin. This operation only works if the layer has been added
- to an image.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><parameter>new_width</parameter> :</entry>
- <entry> New layer width.
- </entry></row>
- <row><entry align="right"><parameter>new_height</parameter> :</entry>
- <entry> New layer height.
- </entry></row>
- <row><entry align="right"><parameter>local_origin</parameter> :</entry>
- <entry> Use a local origin (as opposed to the image origin).
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-resize">gimp_layer_resize ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_resize (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gint">gint</link> new_width,
- <link linkend="gint">gint</link> new_height,
- <link linkend="gint">gint</link> offx,
- <link linkend="gint">gint</link> offy);</programlisting>
- <para>
- Resize the layer to the specified extents.
- </para>
- <para>
- This procedure resizes the layer so that it's new width and height
- are equal to the supplied parameters. Offsets are also provided
- which describe the position of the previous layer's content. This
- operation only works if the layer has been added to an image.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><parameter>new_width</parameter> :</entry>
- <entry> New layer width.
- </entry></row>
- <row><entry align="right"><parameter>new_height</parameter> :</entry>
- <entry> New layer height.
- </entry></row>
- <row><entry align="right"><parameter>offx</parameter> :</entry>
- <entry> x offset between upper left corner of old and new layers: (new - old).
- </entry></row>
- <row><entry align="right"><parameter>offy</parameter> :</entry>
- <entry> y offset between upper left corner of old and new layers: (new - old).
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-delete">gimp_layer_delete ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_delete (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
- <para>
- Delete a layer.
- </para>
- <para>
- This procedure deletes the specified layer. This must not be done if
- the gimage containing this layer was already deleted or if the layer
- was already removed from the image. The only case in which this
- procedure is useful is if you want to get rid of a layer which has
- not yet been added to an image.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer to delete.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-translate">gimp_layer_translate ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_translate (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gint">gint</link> offx,
- <link linkend="gint">gint</link> offy);</programlisting>
- <para>
- Translate the layer by the specified offsets.
- </para>
- <para>
- This procedure translates the layer by the amounts specified in the
- x and y arguments. These can be negative, and are considered offsets
- from the current position. This command only works if the layer has
- been added to an image. All additional layers contained in the image
- which have the linked flag set to TRUE w ill also be translated by
- the specified offsets.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><parameter>offx</parameter> :</entry>
- <entry> Offset in x direction.
- </entry></row>
- <row><entry align="right"><parameter>offy</parameter> :</entry>
- <entry> Offset in y direction.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-add-alpha">gimp_layer_add_alpha ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_add_alpha (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
- <para>
- Add an alpha channel to the layer if it doesn't already have one.
- </para>
- <para>
- This procedure adds an additional component to the specified layer
- if it does not already possess an alpha channel. An alpha channel
- makes it possible to move a layer from the bottom of the layer stack
- and to clear and erase to transparency, instead of the background
- color. This transforms images of type RGB to RGBA, GRAY to GRAYA,
- and INDEXED to INDEXEDA.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-set-offsets">gimp_layer_set_offsets ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_offsets (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gint">gint</link> offx,
- <link linkend="gint">gint</link> offy);</programlisting>
- <para>
- Set the layer offsets.
- </para>
- <para>
- This procedure sets the offsets for the specified layer. The offsets
- are relative to the image origin and can be any values. This
- operation is valid only on layers which have been added to an image.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><parameter>offx</parameter> :</entry>
- <entry> Offset in x direction.
- </entry></row>
- <row><entry align="right"><parameter>offy</parameter> :</entry>
- <entry> Offset in y direction.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-mask">gimp_layer_mask ()</title>
- <programlisting><link linkend="gint32">gint32</link> gimp_layer_mask (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
- <para>
- Get the specified layer's mask if it exists.
- </para>
- <para>
- This procedure returns the specified layer's mask, or -1 if none
- exists.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The layer mask.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-is-floating-sel">gimp_layer_is_floating_sel ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_is_floating_sel (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
- <para>
- Is the specified layer a floating selection?
- </para>
- <para>
- This procedure returns whether the layer is a floating selection.
- Floating selections are special cases of layers which are attached
- to a specific drawable.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> Non-zero if the layer is a floating selection.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-get-name">gimp_layer_get_name ()</title>
- <programlisting><link linkend="gchar">gchar</link>* gimp_layer_get_name (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
- <para>
- Get the name of the specified layer.
- </para>
- <para>
- This procedure returns the specified layer's name.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The layer name.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-set-name">gimp_layer_set_name ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_name (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gchar">gchar</link> *name);</programlisting>
- <para>
- Set the name of the specified layer.
- </para>
- <para>
- This procedure sets the specified layer's name.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><parameter>name</parameter> :</entry>
- <entry> The new layer name.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-get-visible">gimp_layer_get_visible ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_get_visible (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
- <para>
- Get the visibility of the specified layer.
- </para>
- <para>
- This procedure returns the specified layer's visibility.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The layer visibility.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-set-visible">gimp_layer_set_visible ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_visible (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gboolean">gboolean</link> visible);</programlisting>
- <para>
- Set the visibility of the specified layer.
- </para>
- <para>
- This procedure sets the specified layer's visibility.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><parameter>visible</parameter> :</entry>
- <entry> The new layer visibility.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-get-preserve-trans">gimp_layer_get_preserve_trans ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_get_preserve_trans (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
- <para>
- Get the preserve transperancy setting of the specified layer.
- </para>
- <para>
- This procedure returns the specified layer's preserve transperancy
- setting.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The layer's preserve transperancy setting.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-set-preserve-trans">gimp_layer_set_preserve_trans ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_preserve_trans (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gboolean">gboolean</link> preserve_trans);</programlisting>
- <para>
- Set the preserve transperancy setting of the specified layer.
- </para>
- <para>
- This procedure sets the specified layer's preserve transperancy
- setting.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><parameter>preserve_trans</parameter> :</entry>
- <entry> The new layer's preserve transperancy setting.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-get-apply-mask">gimp_layer_get_apply_mask ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_get_apply_mask (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
- <para>
- Get the apply mask setting of the specified layer.
- </para>
- <para>
- This procedure returns the specified layer's apply mask setting. If
- the value is non-zero, then the layer mask for this layer is
- currently being composited with the layer's alpha channel.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The layer's apply mask setting.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-set-apply-mask">gimp_layer_set_apply_mask ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_apply_mask (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gboolean">gboolean</link> apply_mask);</programlisting>
- <para>
- Set the apply mask setting of the specified layer.
- </para>
- <para>
- This procedure sets the specified layer's apply mask setting. This
- controls whether the layer's mask is currently affecting the alpha
- channel. If there is no layer mask, this function will return an
- error.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><parameter>apply_mask</parameter> :</entry>
- <entry> The new layer's apply mask setting.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-get-show-mask">gimp_layer_get_show_mask ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_get_show_mask (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
- <para>
- Get the show mask setting of the specified layer.
- </para>
- <para>
- This procedure returns the specified layer's show mask setting. If
- the value is non-zero, then the layer mask for this layer is
- currently being shown instead of the layer.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The layer's show mask setting.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-set-show-mask">gimp_layer_set_show_mask ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_show_mask (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gboolean">gboolean</link> show_mask);</programlisting>
- <para>
- Set the show mask setting of the specified layer.
- </para>
- <para>
- This procedure sets the specified layer's show mask setting. This
- controls whether the layer or it's mask is visible. Non-zero values
- indicate that the mask should be visible. If the layer has no mask,
- then this function returns an error.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><parameter>show_mask</parameter> :</entry>
- <entry> The new layer's show mask setting.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-get-edit-mask">gimp_layer_get_edit_mask ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_get_edit_mask (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
- <para>
- Get the show mask setting of the specified layer.
- </para>
- <para>
- This procedure returns the specified layer's show mask setting. If
- the value is non-zero, then the layer mask for this layer is
- currently active, and not the layer.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The layer's show mask setting.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-set-edit-mask">gimp_layer_set_edit_mask ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_edit_mask (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gboolean">gboolean</link> edit_mask);</programlisting>
- <para>
- Set the show mask setting of the specified layer.
- </para>
- <para>
- This procedure sets the specified layer's show mask setting. This
- controls whether the layer or it's mask is currently active for
- editing. If the specified layer has no layer mask, then this
- procedure will return an error.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><parameter>edit_mask</parameter> :</entry>
- <entry> The new layer's show mask setting.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-get-opacity">gimp_layer_get_opacity ()</title>
- <programlisting><link linkend="gdouble">gdouble</link> gimp_layer_get_opacity (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
- <para>
- Get the opacity of the specified layer.
- </para>
- <para>
- This procedure returns the specified layer's opacity.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The layer opacity.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-set-opacity">gimp_layer_set_opacity ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_opacity (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gdouble">gdouble</link> opacity);</programlisting>
- <para>
- Set the opacity of the specified layer.
- </para>
- <para>
- This procedure sets the specified layer's opacity.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><parameter>opacity</parameter> :</entry>
- <entry> The new layer opacity.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-get-mode">gimp_layer_get_mode ()</title>
- <programlisting><link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> gimp_layer_get_mode (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
- <para>
- Get the combination mode of the specified layer.
- </para>
- <para>
- This procedure returns the specified layer's combination mode.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The layer combination mode.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-set-mode">gimp_layer_set_mode ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_mode (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="GimpLayerModeEffects">GimpLayerModeEffects</link> mode);</programlisting>
- <para>
- Set the combination mode of the specified layer.
- </para>
- <para>
- This procedure sets the specified layer's combination mode.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><parameter>mode</parameter> :</entry>
- <entry> The new layer combination mode.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-get-linked">gimp_layer_get_linked ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_get_linked (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
- <para>
- Get the linked state of the specified layer.
- </para>
- <para>
- This procedure returns the specified layer's linked state.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The layer linked state (for moves).
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-set-linked">gimp_layer_set_linked ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_linked (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gboolean">gboolean</link> linked);</programlisting>
- <para>
- Set the linked state of the specified layer.
- </para>
- <para>
- This procedure sets the specified layer's linked state.</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><parameter>linked</parameter> :</entry>
- <entry> The new layer linked state.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-get-tattoo">gimp_layer_get_tattoo ()</title>
- <programlisting><link linkend="gint">gint</link> gimp_layer_get_tattoo (<link linkend="gint32">gint32</link> layer_ID);</programlisting>
- <para>
- Get the tattoo of the specified layer.
- </para>
- <para>
- This procedure returns the specified layer's tattoo. A tattoo is a
- unique and permanent identifier attached to a layer that can be used
- to uniquely identify a layer within an image even between sessions</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> The layer tattoo.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-set-tattoo">gimp_layer_set_tattoo ()</title>
- <programlisting><link linkend="gboolean">gboolean</link> gimp_layer_set_tattoo (<link linkend="gint32">gint32</link> layer_ID,
- <link linkend="gint">gint</link> tattoo);</programlisting>
- <para>
- Set the tattoo of the specified layer.
- </para>
- <para>
- This procedure sets the specified layer's tattoo. A tattoo is a
- unique and permanent identifier attached to a layer that can be used
- to uniquely identify a layer within an image even between sessions</para>
- <para>
-
- </para><informaltable pgwide=1 frame="none" role="params">
- <tgroup cols="2">
- <colspec colwidth="2*">
- <colspec colwidth="8*">
- <tbody>
- <row><entry align="right"><parameter>layer_ID</parameter> :</entry>
- <entry> The layer.
- </entry></row>
- <row><entry align="right"><parameter>tattoo</parameter> :</entry>
- <entry> The new layer tattoo.
- </entry></row>
- <row><entry align="right"><emphasis>Returns</emphasis> :</entry><entry> TRUE on success.
- </entry></row>
- </tbody></tgroup></informaltable></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-get-mask-id">gimp_layer_get_mask_id</title>
- <programlisting>#define gimp_layer_get_mask_id gimp_layer_mask
- </programlisting>
- <para>
-
- </para></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-get-image-id">gimp_layer_get_image_id</title>
- <programlisting>#define gimp_layer_get_image_id gimp_drawable_image
- </programlisting>
- <para>
-
- </para></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-is-floating-selection">gimp_layer_is_floating_selection</title>
- <programlisting>#define gimp_layer_is_floating_selection gimp_layer_is_floating_sel
- </programlisting>
- <para>
-
- </para></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-get-preserve-transparency">gimp_layer_get_preserve_transparency</title>
- <programlisting>#define gimp_layer_get_preserve_transparency gimp_layer_get_preserve_trans
- </programlisting>
- <para>
-
- </para></refsect2>
- <refsect2>
- <title><anchor id="gimp-layer-set-preserve-transparency">gimp_layer_set_preserve_transparency</title>
- <programlisting>#define gimp_layer_set_preserve_transparency gimp_layer_set_preserve_trans
- </programlisting>
- <para>
-
- </para></refsect2>
-
- </refsect1>
-
-
-
-
- </refentry>
-